Cytosim  PI
Cytoskeleton Simulator
Display Parameters: View

Variables

real zoom
 zoom factor = ratio between visible area and view_size
 
real view_size
 size of area visible in the window, in sim-units (default=10)
 
unsigned int auto_scale
 enables the display area to be set from the size of the simulation space More...
 
Vector3 focus
 the point that is in the center of the window in real-world coordinates
 
Vector3 focus_shift
 additional translation used by autoTrack
 
Quaternion< realrotation
 orientation of display
 
unsigned int traveling
 enables auto_translation, auto_zoom or auto_rotation More...
 
Vector3 auto_translation
 translation speed of display (known as traveling[1]) More...
 
Quaternion< realauto_rotation
 rotational speed of display (known as traveling[2]) More...
 
real auto_zoom
 zooming speed of display (known as traveling[3]) More...
 
int window_position [2]
 position of window on screen (top-left corner, in pixels)
 
unsigned int window_size [2]
 desired size of window in pixels (also known as size)
 
real scale_bar
 size of scale-bar in sim-world units
 
unsigned int show_scale
 display flag for scale-bar (set as scale_bar[1])
 
unsigned int show_axes
 display flag for axes
 
unsigned int clip_plane_mode [NB_CLIP_PLANES]
 on/off flags for clipping (defined as clip_plane?) More...
 
Vector3 clip_plane_vector [NB_CLIP_PLANES]
 direction perpendicular to clipping plane (defined as clip_plane?[1])
 
real clip_plane_scalar [NB_CLIP_PLANES]
 scalar offset defining the equation of the clipping plane (defined as clip_plane?[2])
 
unsigned int track_fibers
 automatically adjust view to keep fibers in window More...
 
int fog_type
 characteristics of OpenGL fog (also known as fog[0])
 
real fog_density
 density of fog (also known as fog[1])
 
gle_color fog_color
 color of fog (also known as fog[2])
 

Detailed Description

Variable Documentation

Quaternion<real> auto_rotation

This is a speed in quaternion / wall-time

unsigned int auto_scale

If ( auto_scale > 0 ), the view_size is set automatically to match the simulation space. This is on by default.

Vector3 auto_translation

This is a speed in distance / wall-time

real auto_zoom

This is a speed in zoom-unit / wall-time

  • auto_zoom > 0 : zoom closer
  • auto_zoom < 0 : zoom away
unsigned int clip_plane_mode[NB_CLIP_PLANES]

Up to 3 clipping planes can be defined: clip_plane0 to clip_plane2

Syntax:

clip_plane? = BOOL, VECTOR, REAL

The Boolean enables the clipping plane. The plane is specified by a normal vector n (VECTOR) and a scalar (REAL). The visible half-space is defined by n.x + a > 0

Example: To define a slice perpendicular to the X-axis of width 2:

set simul:display *
{
clip_plane1 = 1, 1 0 0, 1
clip_plane2 = 1, -1 0 0, 1
}
unsigned int track_fibers

Possible values:

  • 0 : off
  • 1 : translate to keep center of gravity in window
  • 2 : translate + rotate to align direction vector
  • 3 : translate + rotate to align with nematic direction tensor

The translation defined by focus is applied after this adjustment.

unsigned int traveling

if ( traveling > 0 ), this sets the interval of time in milli-seconds at which the model-view transformation will be updated, by applying auto_translation, auto_zoom and auto_rotation.